Assurance API
API Resources
The Assurance API allows you to:
- Retrieve product instance details
- Diagnose a fault
- Log a fault
- Manage faults
- View and schedule appointments
- View network events
- Subscribe to receive notifications and status updates
The Assurance API includes the following resources:
| Method and endpoint | Function |
|---|---|
GET /version | Retrieve the full version number of the API asset (major, minor and patch version numbers). |
GET /authorization | Get Authorization Application information. |
POST /sessions | Create a new diagnostic session. |
GET /sessions | Retrieve a set of diagnostic sessions. |
GET /sessions/{sessionid} | Retrieve a diagnostic session. |
GET /sessions/{sessionid}/schedule | Retrieve schedule details based on search criteria. |
POST /sessions/{sessionid}/reservations | Submit a Schedule Reservation Request for the Diagnostic Session. |
POST /sessions/{sessionid}/faultType | Update the fault type for the diagnostic session. |
POST /sessions/{sessionid}/problemReport | Submit a problem report for the diagnostic session. |
PUT /sessions/{sessionid}/cancel | Cancel a diagnostic session. |
POST /sessions/{sessionid}/diagnostics | Create a diagnostic test run. |
GET /sessions/{sessionid}/diagnostics/{diagnosticidentifier} | Retrieve a diagnostic test run. |
GET /products/{productid} | Get product information. |
POST /products/{productid}/factoryReset | Initiate a factory reset of RGW ONT. |
POST /products/{productid}/reboot | Initiate a reboot of RGW ONT. |
GET /products/{productid}/wifi | Get Wi-Fi Configuration associated to product. |
PUT /products/{productid}/wifi/{wifiPortIndex} | Modify Wi-Fi Configuration associated to product |
POST /products/{productid}/wifi/{wifiPortIndex}/reset | Reset wireless service details for a single wlan associated with a product. |
GET /products/{productid}/wan | Get WAN Configuration associated to product. |
PUT /products/{productid}/wan | Modify WAN Configuration associated to product. |
GET /products/{productid}/voice | Get list of Voice profiles and voice port details associated to product. |
PUT /products/{productid}/voice/{voiceProfileIndex} | Modify Voice service details for a single Voice profile associated to product. |
PUT /products/{productid}/voice/{voiceProfileIndex}/voicePort/{voicePortIndex} | Modify Voice service details for a single Voice port associated to product. |
GET /products/{productid}/lan/ethernetPorts | Get LAN port details associated to product. |
PUT /products/{productid}/lan/ethernetPorts/{ethernetPortIndex} | Modify LAN port details associated to product. |
GET /products/{productid}/lan/staticIps | Get LAN Static IP addresses associated to product. |
PUT /products/{productid}/lan/staticIps | Set LAN Static IP addresses associated to product. |
GET /products/{productid}/lan/dhcpIp | Get LAN DHCP and IP configuration associated to product. |
PUT /products/{productid}/lan/dhcpIp | Set LAN DHCP and IP configuration associated to product. |
GET /products/{productid}/lan/hosts | Get hosts connected to associated product. |
GET /problemReport | Retrieve a set of problem reports. |
GET /problemReport/{problemnumber} | Retrieve a problem report. |
PUT /problemReport/{problemnumber} | Amend a problem report. |
POST /problemReport/{problemnumber}/close | Close a problem report. |
POST /problemReport/{problemnumber}/cancel | Cancel a problem report. |
POST /problemReport/{problemnumber}/update | Update a problem report. |
POST /problemReport/{problemnumber}/unlink | Unlink a problem report from an event. |
GET /events/{event_id} | Retrieve an event. |
GET /events/{event_id}/impact | Retrieve event impacts. |
GET /events/{event_id}/impactDownload | Download Event Impacts. |
GET /tests | Get tests. |
GET /tests/{testId} | Get a specific test. |
GET /tests/{testId}/images/{imageid} | Get test images. |
GET /subscriptions | Get subscription details. |
POST /subscriptons | Create a new subscription. Note: This requires a manual configuration change in Chorus's systems. See How to use the API for more details. |
GET /subscriptons/{subscriptionid} | Reference a subscription. |
PUT /subscriptons/{subscriptionid} | Update a subscription. |
POST /subscriptions/{subscriptionid}/delete | Delete a subscription. |
POST /subscriptions/{subscriptionid}/deactivate | Deactivate a subscription. |
GET /channels/{channelId}/notifications | Get notifications by channel. |
GET /channels/{channelId}/notifications/{notificationsid} | Used to reference notification to retrieve information. |